home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / mg2a_src.zip / MG.TEX (.txt) < prev    next >
LaTeX Document  |  1988-08-23  |  52KB  |  1,022 lines
  1. \batchmode %be nice to fellow VAXers
  2. \hoffset=0in \voffset=0in %correct dvi2ln3 bug
  3. \documentstyle[11pt,titlepage]{report}
  4. %\pagestyle{headings} %not sure on this one yet
  5. %\parindent=0in
  6. \textwidth=6in
  7. \oddsidemargin=0.25in
  8. % definitions for DEFINE environment
  9. \newlength{\lblwide}
  10. \newcommand{\resetmarg}{\settowidth{\leftmargin}{\makebox[\lblwide]{}\makebox[\labelsep]{}}}
  11. \newcommand{\resetlbl}{\setlength{\labelwidth}{\lblwide}} 
  12. \newenvironment{define}[1]{\begin{list}{}{\settowidth{\lblwide}{\bf #1}\resetmarg \resetlbl}}{\end{list}}
  13. % definitions for fn environment
  14. \newcommand{\fname}[3]{\hspace{1em}\\{\tt #1}\index{#1} {\it #2}\hfill{\tt #3}}
  15. \newcommand{\fmore}[3]{\\{\tt #1}\index{#1} {\it #2}\hfill{\tt #3}}
  16. \newcommand{\fbody}{\\[0.5em]}
  17. % definitions for making the index
  18. \newcommand{\indexentry}[2]{\item {\tt #1} \dotfill\  #2}
  19. \setcounter{secnumdepth}{5} %personal preference
  20. \setcounter{tocdepth}{5} %personal preference
  21. \author{Sandra J. Loosemore}
  22. \title{The MG Reference Manual \\ Release MG2A}
  23. \date{\vspace{1.5in}
  24. Copyright \copyright 1987, Sandra J. Loosemore \\[0.5em]
  25. \parbox{5 in}{This document, or sections of this document, may be freely
  26. redistributed provided that the copyright notice and the following disclaimer
  27. remain intact:  The author bears no responsibilities for errors in
  28. this document or the software it describes; and shall not be held liable
  29. for any indirect, incidental, or consequential damages.}}
  30. \makeindex %usually not
  31. \begin{document}
  32. \maketitle
  33. \tableofcontents
  34. \chapter{Introduction}
  35. MG is a small, fast, and portable Emacs-style text editor intended to
  36. be used by people who can't run a real Emacs for one reason or another
  37. --- as their main editor on smaller machines with limited memory or
  38. file space, or as a ``quick-start'' editor on larger systems, useful
  39. for composing short mail messages and the like. 
  40. We've made MG compatible with GNU Emacs because that is the ``big'',
  41. full-featured editor that many of us use regularly and are most
  42. familiar with.  GNU Emacs is the creation of Richard M. Stallman, who
  43. was also the author of the original Emacs editor.  However, MG is not
  44. associated in any way with the GNU project, and the MG authors
  45. individually may or may not agree with the opinions expressed by
  46. Richard Stallman and the GNU project. 
  47. MG is largely public domain.  You can use, modify, and redistribute MG
  48. as you like.  A few modules, however, are copyrighted; specifically,
  49. the regular expression code, the VMS termcap routines, and the Amiga
  50. support code.  Look at the source code for the exact copyright
  51. restrictions. 
  52. There are several other editors in existence which call themselves
  53. MicroEmacs.  The original public domain version was written by Dave
  54. Conroy and circulated as version 1.6.  Derived from this, there is
  55. another PD version by Dave Conroy numbered v30; a significantly larger
  56. PD version by Daniel Lawrence which is now up to version 3.9; at least
  57. one proprietary implementation; an implementation for the Atari ST
  58. with an integrated command shell, by Prabhaker Mateti; and probably
  59. others that we don't know about.
  60. MG is derived from the v30 MicroEmacs, with key bindings, command
  61. names, and general functionality made more compatible with GNU Emacs.
  62. Like v30, MG is fairly small and quite robust.  We have generally
  63. resisted the temptation to overfeaturize.  Some features which are
  64. large and complex are flagged for conditional compilation.
  65. Many people have contributed their time to developing, improving, and
  66. porting MG.  Mike Meyer, Mic Kaczmarczik, and Bob Larson deserve 
  67. particular mention for their efforts.  
  68. Questions, suggestions, and offers of help should be addressed to:
  69. \begin{verbatim}
  70.         mg-developers@ucbvax.berkeley.edu   (ARPA)
  71.         ucbvax!mg-developers                (UUCP)
  72. \end{verbatim}
  73. \section{Implementations of MG}
  74. MG runs on many different kinds of hardware under many different 
  75. operating systems.  Currently, these include:
  76. \begin{itemize}
  77. \item 4.2 and 4.3 BSD Unix (including Ultrix-32)
  78. \item System V Unix
  79. \item VAX/VMS
  80. \item Primos
  81. \item OS9/68k
  82. \item Amiga
  83. \item Atari ST
  84. \item MS-DOS
  85. \end{itemize}
  86. This document describes release MG2A.  When we talk of different
  87. versions of MG in this manual, the term {\em version\/} is used to
  88. refer to the different support MG provides for the various machines
  89. and operating systems it runs under, not to different releases of MG
  90. itself.  For example, we might speak of how the VMS version of MG
  91. differs from the Unix version.
  92. As mentioned above, some MG commands may not be implemented in all
  93. versions; these are noted in the documentation.  Some versions of MG
  94. also support features (such as mouse handling) that are not described
  95. here.
  96. \section{A Note on Character Sets}
  97. MG uses the 128-character ASCII character set, and provides support for
  98. 8-bit characters.  Whether the particular version of MG that you are running
  99. knows about extended character sets depends on whether your terminal and
  100. the host operating system know about them.  Moreover, since there is no
  101. standard 8-bit character set, the same character codes will probably
  102. give different glyphs on different systems.  Most versions of MG use
  103. the DEC multinational character set.
  104. \section{Notation and Conventions}
  105. In this manual, commands and other things that must be typed in 
  106. literally are indicated in a typewriter font, like {\tt next-line}.
  107. Placeholders such as command argument names use an italic font.
  108. The terms {\em command\/} and {\em function\/} are synonymous.  We often
  109. speak of a command being bound to a particular {\em key\/}, although you 
  110. may actually have to type more than one character to form a single key.
  111. Most commands are bound to keys with {\em control\/} and {\em meta\/} 
  112. modifiers.
  113. To type a control character, use the control key on your
  114. keyboard like a shift key:  hold down the control key while typing the
  115. character.  In this manual, we will indicate control characters like
  116. \verb"C-x" --- here, typing the character ``x'' while holding down
  117. the control key.
  118. Some keyboards also have a meta key that works like the control
  119. key.  (It may be labelled something else;  on the Atari ST, for example,
  120. the key marked  ``Alternate'' is the meta key.)  If your keyboard doesn't
  121. have a meta key, don't panic.  You can also use the escape key as a meta
  122. prefix; first type the escape, and {\em then\/} the character.  Meta
  123. characters will be indicated as \verb"M-x".
  124. Besides the meta prefix, two other characters are used as prefixes:
  125. \verb"C-x" and \verb"C-h".  A few keys have special notation:  {\tt SPC} is
  126. the space character, {\tt DEL} is the delete or rubout character, {\tt RET}
  127. is carriage return, and {\tt ESC} is the escape character.  {\tt NUL} is 
  128. the null character (ASCII 0), which is usually equivalent to either 
  129. \verb"C-SPC" or \verb"C-@".
  130. Uppercase and lowercase characters are generally equivalent in command
  131. keystrokes.
  132. When you run MG from a shell, command line arguments are interpreted as the
  133. names of files you want to {\em visit\/}, or edit.  Each file is 
  134. read into a {\em buffer\/} in memory.  No changes are actually made to 
  135. the file until you ask it to be written out to disk.
  136. Within MG, the large top part of the screen serves as a {\em window\/} into
  137. the buffer being edited.  Below this is the {\em mode line\/}, which 
  138. displays the name of the buffer.  Finally, at the very bottom of the screen,
  139. there is a one-line {\em minibuffer\/} which is used for displaying
  140. messages and answering questions.
  141. MG keeps track of two pointers into each window, the {\em point\/} and the
  142. {\em mark\/}.  The {\em cursor\/} appears at the point in the current
  143. window, and we often speak of moving the cursor rather than of moving the
  144. point.  The text between the point and the mark is referred to as the {\em
  145. region\/}.
  146. Some commands deal with {\em words\/} and {\em paragraphs\/}.
  147. Generally, whitespace and punctuation separate words.  Lines that are
  148. empty or that contain only spaces or tabs separate paragraphs without
  149. being part of a paragraph.  A non-empty line that starts with a space
  150. or tab also begins a new paragraph. 
  151. A number of commands are defined as {\em toggles\/}.  If no prefix argument
  152. is supplied,